Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update capitalization of "Mbed" and fix bump_version.sh #8034

Merged
merged 3 commits into from
Sep 13, 2023
Merged

Update capitalization of "Mbed" and fix bump_version.sh #8034

merged 3 commits into from
Sep 13, 2023

Conversation

gilles-peskine-arm
Copy link
Contributor

@gilles-peskine-arm gilles-peskine-arm commented Aug 4, 2023 •
edited
Loading

  • Update the spelling of "Mbed TLS". The official spelling used to be "mbed TLS" but changed a few years ago and we haven't caught up. Keep the old spelling in places where it can change things: where it gets embedded in test certificates, and in an imported file.
  • Fix a bug in bump_version.sh (already noticed in the 3.4.0 release) that caused it to miss a file due to the spelling change.

PR checklist

Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")

@gilles-peskine-arm gilles-peskine-arm added needs-review Every commit must be reviewed by at least two team members, needs-reviewer This PR needs someone to pick it up for review priority-medium Medium priority - this can be reviewed as time permits size-xs Estimated task size: extra small (a few hours at most) labels Aug 4, 2023
@tgonzalezorlandoarm tgonzalezorlandoarm self-requested a review August 22, 2023 11:24
@gilles-peskine-arm gilles-peskine-arm mentioned this pull request Sep 7, 2023
Merged
3 tasks
@daverodgman
Copy link
Contributor

This misses programs/x509/cert_write and programs/x509/cert_req - is that intentional?

@gilles-peskine-arm
Copy link
Contributor Author

@daverodgman yes

daverodgman
daverodgman previously approved these changes Sep 7, 2023
View reviewed changes
@tom-cosgrove-arm
Copy link
Contributor

Should we not also have

diff --git a/tests/data_files/Makefile b/tests/data_files/Makefile
index eff44d8ac..fc23e3f28 100644
--- a/tests/data_files/Makefile
+++ b/tests/data_files/Makefile
@@ -1,7 +1,7 @@
 ## This file contains a record of how some of the test data was
 ## generated. The final build products are committed to the repository
 ## as well to make sure that the test data is identical. You do not
-## need to use this makefile unless you're extending mbed TLS's tests.
+## need to use this makefile unless you're extending Mbed TLS's tests.

 ## Many data files were generated prior to the existence of this
 ## makefile, so the method of their generation was not recorded.

@tom-cosgrove-arm
Copy link
Contributor

Note: conflicts

@tom-cosgrove-arm tom-cosgrove-arm added needs-work needs-ci Needs to pass CI tests and removed needs-reviewer This PR needs someone to pick it up for review labels Sep 12, 2023
@gilles-peskine-arm
Allow "Mbed TLS" as the project name in Doxygen
4843278 
Previously the code only recognized the old spelling "mbed TLS", so it
missed doxygen/input/doc_mainpage.h.

Signed-off-by: Gilles Peskine <[email protected]>
@gilles-peskine-arm
Update spelling "mbed TLS" to "Mbed TLS"
e820c0a 
The official spelling of the trade mark changed from all-lowercase "mbed"
to normal proper noun capitalization "Mbed" a few years ago. We've been
using the new spelling in new text but still have the old spelling in a
lot of text. This commit updates most occurrences of "mbed TLS":

```
sed -i -e 's/mbed TLS/Mbed TLS/g' $(git ls-files ':!ChangeLog' ':!tests/data_files/**' ':!tests/suites/*.data' ':!programs/x509/*' ':!configs/tfm*')
```

Justification for the omissions:

* `ChangeLog`: historical text.
* `test/data_files/**`, `tests/suites/*.data`, `programs/x509/*`: many
  occurrences are significant names in certificates and such. Changing
  the spelling would invalidate many signatures and tests.
* `configs/tfm*`: this is an imported file. We'll follow the upstream
  updates.

Signed-off-by: Gilles Peskine <[email protected]>
@gilles-peskine-arm
More spelling corrections
2e38a0d 
Signed-off-by: Gilles Peskine <[email protected]>
@gilles-peskine-arm
Copy link
Contributor Author

There were merge conflicts so I rebased. I applied the same script from the changelog message to re-do the big capitalization commit.

@gilles-peskine-arm gilles-peskine-arm mentioned this pull request Sep 12, 2023
Merged
3 tasks
@gilles-peskine-arm gilles-peskine-arm removed the request for review from tom-cosgrove-arm September 12, 2023 17:25
tom-cosgrove-arm
tom-cosgrove-arm approved these changes Sep 13, 2023
View reviewed changes
Copy link
Contributor

@tom-cosgrove-arm tom-cosgrove-arm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tom-cosgrove-arm tom-cosgrove-arm added approved Design and code approved - may be waiting for CI or backports and removed needs-review Every commit must be reviewed by at least two team members, needs-ci Needs to pass CI tests labels Sep 13, 2023
@daverodgman daverodgman added this pull request to the merge queue Sep 13, 2023
Merged via the queue into Mbed-TLS:development with commit da0bb9f Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tom-cosgrove-arm tom-cosgrove-arm tom-cosgrove-arm approved these changes

@daverodgman daverodgman daverodgman approved these changes

@tgonzalezorlandoarm tgonzalezorlandoarm Awaiting requested review from tgonzalezorlandoarm

Assignees
No one assigned
Labels
approved Design and code approved - may be waiting for CI or backports priority-medium Medium priority - this can be reviewed as time permits size-xs Estimated task size: extra small (a few hours at most)
Projects
Non-roadmap pull requests
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gilles-peskine-arm @daverodgman @tom-cosgrove-arm @tgonzalezorlandoarm